/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2012 Neil C Smith.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details.
 *
 * You should have received a copy of the GNU General Public License version 2
 * along with this work; if not, see http://www.gnu.org/licenses/
 * 
 *
 * Linking this work statically or dynamically with other modules is making a
 * combined work based on this work. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this work give you permission
 * to link this work with independent modules to produce an executable,
 * regardless of the license terms of these independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module. An independent module is a module which is not
 * derived from or based on this work. If you modify this work, you may extend
 * this exception to your version of the work, but you are not obligated to do so.
 * If you do not wish to do so, delete this exception statement from your version.
 *
 * Please visit http://neilcsmith.net if you need additional information or
 * have any questions.
 */
package org.jaudiolibs.pipes;

/**
 *
 * @author Neil C Smith (http://neilcsmith.net)
 */
public abstract class Pipe {
    
    public final void addSource(Pipe source) {
        source.registerSink(this);
        try {
            registerSource(source);
        } catch (RuntimeException ex) {
            source.unregisterSink(this);
            throw ex;
        }   
    }
    
    public final void removeSource(Pipe source) {
        source.unregisterSink(this);
        unregisterSource(source);
    }
    
    public abstract int getSourceCount();
    
    public abstract int getSourceCapacity();
    
    public abstract Pipe getSource(int idx);
    
    public abstract int getSinkCount();
    
    public abstract int getSinkCapacity();
    
    public abstract Pipe getSink(int idx);
    
    protected final void callSource(Pipe source, Buffer buffer, long time) {
        source.process(this, buffer, time);
    }
    
    protected final boolean sinkRequiresRender(Pipe sink, long time) {
        return sink.isRenderRequired(this, time);
    }
    
    protected abstract void process(Pipe sink, Buffer buffer, long time);
    
    protected abstract boolean isRenderRequired(Pipe source, long time);
    
    protected abstract void registerSource(Pipe source);
    
    protected abstract void unregisterSource(Pipe source);
    
    protected abstract void registerSink(Pipe sink);
    
    protected abstract void unregisterSink(Pipe sink);
    
    
    
    
}
